跳到主要内容

项目依赖管理

CMake 的默认查找路径​

CMake 在搜索库和头文件时遵循一些默认的路径搜索规则，这些规则可能会根据操作系统、CMake 版本和项目的配置略有不同。以下是一些基本的指南，说明 CMake 如何在不同环境中查找这些资源：

首先是 标准系统目录

  • 对于头文件，CMake 会在标准的系统包含目录中搜索，这通常包括 /usr/include、/usr/local/include 在 Linux 和 macOS 上，以及相应的 Visual Studio、Windows SDK 包含目录在 Windows 上。

  • 对于库文件，CMake 会搜索系统的标准库目录，例如 /usr/lib、/usr/local/lib 在 Linux 和 macOS 上，以及 Windows 上的 Visual Studio 和 Windows SDK 库目录。

CMake 也会考虑环境变量，例如 PATH、LIB、INCLUDE 在 Windows 上，和 LD_LIBRARY_PATH、LIBRARY_PATH、CPATH 等在 Unix-like 系统上。这些环境变量可以指向额外的库和头文件的位置。

CMake 的两种查找模式​

首先是 CMake Module 模式和 Config 模式

find_package 可以以两种模式工作：Module 模式和 Config 模式。它首先尝试 Config 模式，这要求库提供了用于 CMake 的配置文件（如 FooConfig.cmake 或 foo-config.cmake），如果找不到配置文件，它会回退到 Module 模式，这时会搜索 FindFoo.cmake 模块（这里的 Foo 是你试图查找的包名）。

find_package(Foo REQUIRED)

# 或者指定模式

find_package(Foo REQUIRED CONFIG)

Config 模式搜索路径​

在 Config 模式下，CMake 会在以下路径中搜索包配置文件：

  • CMAKE_PREFIX_PATH 和 CMAKE_FRAMEWORK_PATH 环境变量指定的路径。
  • cmake 命令行通过 -DCMAKE_PREFIX_PATH 指定的路径。
  • 库的标准安装路径，如 /usr/local/、/usr/ 等（在 Unix 系统上），或类似 C:/Program Files/（在 Windows 上）。
  • 如果设置了 PackageName_ROOT（PackageName 是 find_package 调用中的包名），CMake 会首先在这个路径下搜索。

Module 模式搜索路径​

在 Module 模式下，CMake 会搜索 FindPackage.cmake 模块，搜索路径包括：

  • CMAKE_MODULE_PATH 变量指定的目录。
  • CMake 自带的模块目录，这允许 find_package 查找许多常见库的模块。

除了上述 CMake 特定的路径，find_package 还可能考虑特定库的环境变量。例如，有些库会在安装时设置环境变量，指向它们的安装位置，而 CMake 可以利用这些环境变量来找到库。

实践建议​

  • 当你安装新的库时，确保库的安装路径被添加到 CMAKE_PREFIX_PATH 或相应的环境变量中，这样 find_package 就可以正确找到它。
  • 使用 find_package 时，阅读库的文档来了解是否提供了用于 CMake 的配置文件，以及如何正确设置路径以便于 find_package 能找到这些文件。
  • 对于较新或较复杂的库，它们可能直接支持 CMake，并提供了配置文件（Config 模式），这通常是首选的查找方式，因为它允许更精确地控制库的使用方式和依赖关系。

找到外部依赖库​

find_package 命令用于查找并加载外部项目或库的配置信息。当 find_package 成功执行后，它通常会设置一些变量，比如包含目录、库文件路径等，以便后续使用。

find_package(LibraryName REQUIRED)

这里的 LibraryName 是你想要添加的依赖库的名称。REQUIRED 参数表示这个库是必须的，如果找不到这个库，CMake 将报错并停止配置过程。

包含目录​

找到依赖库后，你需要确保你的项目可以找到这个库的头文件。include_directories 命令会影响所有的目标（如可执行文件和库），而 target_include_directories 可以更精细地控制特定目标的包含目录。

# 对所有目标设置
include_directories(${LibraryName_INCLUDE_DIRS})

# 对特定目标设置
target_include_directories(YourTarget PRIVATE ${LibraryName_INCLUDE_DIRS})

链接库​

最后一步是链接依赖库。target_link_libraries 命令将库文件链接到你的目标上，无论是可执行文件还是其他库。

target_link_libraries(YourTarget PRIVATE ${LibraryName_LIBRARIES})

这里，YourTarget 是你的项目中已经定义的目标名称（通过 add_executable 或 add_library 创建）。PRIVATE 关键字表示链接是私有的，链接的库仅对当前目标可见，不会影响链接了当前目标的其他目标。

实际例子：添加 OpenCV 依赖​

以下是一个如何在你的项目中添加 OpenCV 作为依赖库的简单示例。

cmake_minimum_required(VERSION 3.0)
project(ExampleProject)

# 查找 OpenCV 包
find_package(OpenCV REQUIRED)

# 添加可执行文件
add_executable(MyApp main.cpp)

# 包含 OpenCV 头文件
target_include_directories(MyApp PRIVATE ${OpenCV_INCLUDE_DIRS})

# 链接 OpenCV 库
target_link_libraries(MyApp PRIVATE ${OpenCV_LIBS})

这个例子中，MyApp 是你的应用程序（目标），main.cpp 是你的源文件。通过 find_package 查找 OpenCV，使用 target_include_directories 和 target_link_libraries 分别添加头文件目录和链接库文件。

注意点：

  • 使用 target_* 命令而不是全局命令（如 include_directories），可以更好地管理大型项目中的依赖关系。
  • PUBLIC, PRIVATE, 和 INTERFACE 关键字控制依赖的传播。PRIVATE 表示依赖仅用于目标自身，PUBLIC 和 INTERFACE 则涉及依赖的传播给其他目标。
  • CMake 的现代用法推荐使用 target_* 命令来设置包含目录和链接库，因为它们提供了更精确的控制和更好的封装性。
编辑此页
最后由 alsritter.mac 于 更新